home *** CD-ROM | disk | FTP | other *** search
/ PC Advisor 2011 May / PC Advisor 190 E.iso / pc / ESSENTIALS / VLC Media Player 1.1 / vlc-1.1.5-win32.exe / sdk / include / vlc / plugins / vlc_plugin.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-11-13  |  18.2 KB  |  469 lines
  1. /*****************************************************************************
  2.  * vlc_plugin.h : Macros used from within a module.
  3.  *****************************************************************************
  4.  * Copyright (C) 2001-2006 the VideoLAN team
  5.  * Copyright ┬⌐ 2007-2009 R├⌐mi Denis-Courmont
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef LIBVLC_MODULES_MACROS_H
  25. # define LIBVLC_MODULES_MACROS_H 1
  26.  
  27. /**
  28.  * \file
  29.  * This file implements plugin (module) macros used to define a vlc module.
  30.  */
  31.  
  32. VLC_EXPORT( int, vlc_plugin_set, (module_t *, module_config_t *, int, ...) );
  33.  
  34. #define vlc_module_set( mod, ... ) vlc_plugin_set ((mod), NULL, __VA_ARGS__)
  35. #define vlc_config_set( cfg, ... ) vlc_plugin_set (NULL, (cfg), __VA_ARGS__)
  36.  
  37. enum vlc_module_properties
  38. {
  39.     VLC_SUBMODULE_CREATE,
  40.     VLC_CONFIG_CREATE,
  41.  
  42.     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  43.      * Append new items at the end ONLY. */
  44.     VLC_MODULE_CPU_REQUIREMENT=0x100,
  45.     VLC_MODULE_SHORTCUT,
  46.     VLC_MODULE_CAPABILITY,
  47.     VLC_MODULE_SCORE,
  48.     VLC_MODULE_CB_OPEN,
  49.     VLC_MODULE_CB_CLOSE,
  50.     VLC_MODULE_NO_UNLOAD,
  51.     VLC_MODULE_NAME,
  52.     VLC_MODULE_SHORTNAME,
  53.     VLC_MODULE_DESCRIPTION,
  54.     VLC_MODULE_HELP,
  55.     VLC_MODULE_TEXTDOMAIN,
  56.     /* Insert new VLC_MODULE_* here */
  57.  
  58.     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  59.      * Append new items at the end ONLY. */
  60.     VLC_CONFIG_NAME=0x1000,
  61.     /* command line name (args=const char *, vlc_callback_t) */
  62.  
  63.     VLC_CONFIG_VALUE,
  64.     /* actual value (args=int/double/const char *) */
  65.  
  66.     VLC_CONFIG_RANGE,
  67.     /* minimum value (args=int/double/const char * twice) */
  68.  
  69.     VLC_CONFIG_ADVANCED,
  70.     /* enable advanced flag (args=none) */
  71.  
  72.     VLC_CONFIG_VOLATILE,
  73.     /* don't write variable to storage (args=none) */
  74.  
  75.     VLC_CONFIG_PERSISTENT,
  76.     /* always write variable to storage (args=none) */
  77.  
  78.     VLC_CONFIG_RESTART,
  79.     /* restart required to apply value change (args=none) */
  80.  
  81.     VLC_CONFIG_PRIVATE,
  82.     /* hide from user (args=none) */
  83.  
  84.     VLC_CONFIG_REMOVED,
  85.     /* tag as no longer supported (args=none) */
  86.  
  87.     VLC_CONFIG_CAPABILITY,
  88.     /* capability for a module or list thereof (args=const char*) */
  89.  
  90.     VLC_CONFIG_SHORTCUT,
  91.     /* one-character (short) command line option name (args=char) */
  92.  
  93.     VLC_CONFIG_OLDNAME,
  94.     /* former option name (args=const char *) */
  95.  
  96.     VLC_CONFIG_SAFE,
  97.     /* tag as modifiable by untrusted input item "sources" (args=none) */
  98.  
  99.     VLC_CONFIG_DESC,
  100.     /* description (args=const char *, const char *, const char *) */
  101.  
  102.     VLC_CONFIG_LIST,
  103.     /* possible values list
  104.      * (args=const char *, size_t, const <type> *, const char *const *) */
  105.  
  106.     VLC_CONFIG_ADD_ACTION,
  107.     /* add value change callback
  108.      * (args=const char *, vlc_callback_t, const char *) */
  109.  
  110.     /* Insert new VLC_CONFIG_* here */
  111. };
  112.  
  113. /*****************************************************************************
  114.  * If we are not within a module, assume we're in the vlc core.
  115.  *****************************************************************************/
  116. #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
  117. #   define MODULE_NAME main
  118. #endif
  119.  
  120. /**
  121.  * Current plugin ABI version
  122.  */
  123. # define MODULE_SYMBOL 1_1_0g
  124. # define MODULE_SUFFIX "__1_1_0g"
  125.  
  126. /*****************************************************************************
  127.  * Add a few defines. You do not want to read this section. Really.
  128.  *****************************************************************************/
  129.  
  130. /* Explanation:
  131.  *
  132.  * if linking a module statically, we will need:
  133.  * #define MODULE_FUNC( zog ) module_foo_zog
  134.  *
  135.  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  136.  */
  137.  
  138. /* I need to do _this_ to change ┬½ foo bar ┬╗ to ┬½ module_foo_bar ┬╗ ! */
  139. #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  140. #define CRUDE_HACK( y, z )  y##__##z
  141.  
  142. /* If the module is built-in, then we need to define foo_InitModule instead
  143.  * of InitModule. Same for Activate- and DeactivateModule. */
  144. #ifdef __PLUGIN__
  145. #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  146. #else
  147. #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  148. #endif
  149.  
  150. #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  151. #   define DLL_SYMBOL              __declspec(dllexport)
  152. #   define CDECL_SYMBOL            __cdecl
  153. #else
  154. #   define DLL_SYMBOL
  155. #   define CDECL_SYMBOL
  156. #endif
  157.  
  158. #if defined( __cplusplus )
  159. #   define EXTERN_SYMBOL           extern "C"
  160. #else
  161. #   define EXTERN_SYMBOL
  162. #endif
  163.  
  164. /*
  165.  * InitModule: this function is called once and only once, when the module
  166.  * is looked at for the first time. We get the useful data from it, for
  167.  * instance the module name, its shortcuts, its capabilities... we also create
  168.  * a copy of its config because the module can be unloaded at any time.
  169.  */
  170. #define vlc_module_begin( )                                                   \
  171.     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
  172.     __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
  173.                                                                               \
  174.     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
  175.     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
  176.     {                                                                         \
  177.         module_config_t *p_config = NULL;                                     \
  178.         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
  179.                             (const char *)(MODULE_STRING)))                   \
  180.             goto error;                                                       \
  181.         {                                                                     \
  182.             module_t *p_submodule = p_module;
  183.  
  184. #define vlc_module_end( )                                                     \
  185.         }                                                                     \
  186.         (void)p_config;                                                       \
  187.         return VLC_SUCCESS;                                                   \
  188.                                                                               \
  189.     error:                                                                    \
  190.         return VLC_EGENERIC;                                                  \
  191.     }                                                                         \
  192.     VLC_METADATA_EXPORTS
  193.  
  194. #define add_submodule( ) \
  195.     if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
  196.         goto error;
  197.  
  198. #define add_shortcut( shortcut ) \
  199.     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
  200.         (const char *)(shortcut))) \
  201.         goto error;
  202.  
  203. #define set_shortname( shortname ) \
  204.     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
  205.                         (const char *)(shortname))) \
  206.         goto error;
  207.  
  208. #define set_description( desc ) \
  209.     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
  210.                         (const char *)(desc))) \
  211.         goto error;
  212.  
  213. #define set_help( help ) \
  214.     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
  215.                         (const char *)(help))) \
  216.         goto error;
  217.  
  218. #define set_capability( cap, score ) \
  219.     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
  220.                         (const char *)(cap)) \
  221.      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
  222.         goto error;
  223.  
  224. #define set_callbacks( activate, deactivate ) \
  225.     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
  226.      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
  227.         goto error;
  228.  
  229. #define cannot_unload_broken_library( ) \
  230.     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
  231.         goto error;
  232.  
  233. #define set_text_domain( dom ) \
  234.     if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
  235.         goto error;
  236.  
  237. /*****************************************************************************
  238.  * Macros used to build the configuration structure.
  239.  *
  240.  * Note that internally we support only 3 types of config data: int, float
  241.  *   and string.
  242.  *   The other types declared here just map to one of these 3 basic types but
  243.  *   have the advantage of also providing very good hints to a configuration
  244.  *   interface so as to make it more user friendly.
  245.  * The configuration structure also includes category hints. These hints can
  246.  *   provide a configuration interface with some very useful data and again
  247.  *   allow for a more user friendly interface.
  248.  *****************************************************************************/
  249.  
  250. #define add_type_inner( type ) \
  251.     vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
  252.  
  253. #define add_typedesc_inner( type, text, longtext ) \
  254.     add_type_inner( type ) \
  255.     vlc_config_set (p_config, VLC_CONFIG_DESC, \
  256.                     (const char *)(text), (const char *)(longtext));
  257.  
  258. #define add_typeadv_inner( type, text, longtext, advc ) \
  259.     add_typedesc_inner( type, text, longtext ) \
  260.     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
  261.  
  262. #define add_typename_inner( type, name, text, longtext, advc, cb ) \
  263.     add_typeadv_inner( type, text, longtext, advc ) \
  264.     vlc_config_set (p_config, VLC_CONFIG_NAME, \
  265.                     (const char *)(name), (vlc_callback_t)(cb));
  266.  
  267. #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
  268.     add_typename_inner( type, name, text, longtext, advc, cb ) \
  269.     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
  270.  
  271. #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
  272.     add_typename_inner( type, name, text, longtext, advc, cb ) \
  273.     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
  274.  
  275.  
  276. #define set_category( i_id ) \
  277.     add_type_inner( CONFIG_CATEGORY ) \
  278.     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
  279.  
  280. #define set_subcategory( i_id ) \
  281.     add_type_inner( CONFIG_SUBCATEGORY ) \
  282.     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
  283.  
  284. #define set_section( text, longtext ) \
  285.     add_typedesc_inner( CONFIG_SECTION, text, longtext )
  286.  
  287. #define add_category_hint( text, longtext, advc ) \
  288.     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
  289.  
  290. #define add_subcategory_hint( text, longtext ) \
  291.     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
  292.  
  293. #define end_subcategory_hint \
  294.     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
  295.  
  296. #define add_usage_hint( text ) \
  297.     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
  298.  
  299. #define add_string( name, value, p_callback, text, longtext, advc ) \
  300.     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
  301.                       p_callback, value )
  302.  
  303. #define add_password( name, value, p_callback, text, longtext, advc ) \
  304.     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
  305.                       p_callback, value )
  306.  
  307. #define add_file( name, value, p_callback, text, longtext, advc ) \
  308.     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
  309.                       p_callback, value )
  310.  
  311. #define add_directory( name, value, p_callback, text, longtext, advc ) \
  312.     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
  313.                       p_callback, value )
  314.  
  315. #define add_font( name, value, p_callback, text, longtext, advc )\
  316.     add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
  317.                       p_callback, value )
  318.  
  319. #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
  320.     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
  321.                       p_callback, value ) \
  322.     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
  323.  
  324. #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
  325.     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
  326.                       p_callback, value ) \
  327.     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
  328.  
  329. #ifndef __PLUGIN__
  330. #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
  331.     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
  332.                       p_callback, value ) \
  333.     change_integer_range (i_subcategory /* gruik */, 0);
  334.  
  335. #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
  336.     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
  337.                       advc, p_callback, value ) \
  338.     change_integer_range (i_subcategory /* gruik */, 0);
  339. #endif
  340.  
  341. #define add_integer( name, value, p_callback, text, longtext, advc ) \
  342.     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
  343.                    p_callback, value )
  344.  
  345. #define add_key( name, value, p_callback, text, longtext, advc ) \
  346.     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
  347.                    p_callback, value ) \
  348.     add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
  349.                    p_callback, KEY_UNSET )
  350.  
  351. #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
  352.     add_integer( name, value, p_callback, text, longtext, advc ) \
  353.     change_integer_range( i_min, i_max )
  354.  
  355. #define add_float( name, v, p_callback, text, longtext, advc ) \
  356.     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
  357.     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
  358.  
  359. #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
  360.     add_float( name, value, p_callback, text, longtext, advc ) \
  361.     change_float_range( f_min, f_max )
  362.  
  363. #define add_bool( name, v, p_callback, text, longtext, advc ) \
  364.     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
  365.                         p_callback ) \
  366.     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
  367.  
  368. /* For removed option */
  369. #define add_obsolete_inner( name, type ) \
  370.     add_type_inner( type ) \
  371.     vlc_config_set (p_config, VLC_CONFIG_NAME, \
  372.                     (const char *)(name), (vlc_callback_t)NULL); \
  373.     vlc_config_set (p_config, VLC_CONFIG_REMOVED);
  374.  
  375. #define add_obsolete_bool( name ) \
  376.         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
  377.  
  378. #define add_obsolete_integer( name ) \
  379.         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
  380.  
  381. #define add_obsolete_float( name ) \
  382.         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
  383.  
  384. #define add_obsolete_string( name ) \
  385.         add_obsolete_inner( name, CONFIG_ITEM_STRING )
  386.  
  387. /* Modifier macros for the config options (used for fine tuning) */
  388.  
  389. #define add_deprecated_alias( name ) \
  390.     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
  391.  
  392. #define change_short( ch ) \
  393.     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
  394.  
  395. #define change_string_list( list, list_text, list_update_func ) \
  396.     vlc_config_set (p_config, VLC_CONFIG_LIST, \
  397.                     (size_t)(sizeof (list) / sizeof (char *)), \
  398.                     (const char *const *)(list), \
  399.                     (const char *const *)(list_text), \
  400.                     (vlc_callback_t)(list_update_func));
  401.  
  402. #define change_integer_list( list, list_text, list_update_func ) \
  403.     vlc_config_set (p_config, VLC_CONFIG_LIST, \
  404.                     (size_t)(sizeof (list) / sizeof (int)), \
  405.                     (const int *)(list), \
  406.                     (const char *const *)(list_text), \
  407.                     (vlc_callback_t)(list_update_func));
  408.  
  409. #define change_integer_range( minv, maxv ) \
  410.     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
  411.  
  412. #define change_float_range( minv, maxv ) \
  413.     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
  414.                     (double)(minv), (double)(maxv));
  415.  
  416. #define change_action_add( pf_action, text ) \
  417.     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
  418.                     (vlc_callback_t)(pf_action), (const char *)(text));
  419.  
  420. #define change_need_restart() \
  421.     vlc_config_set (p_config, VLC_CONFIG_RESTART);
  422.  
  423. #define change_autosave() \
  424.     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
  425.  
  426. /* For options that are saved but hidden from the preferences panel */
  427. #define change_private() \
  428.     vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
  429.  
  430. /* For options that cannot be saved in the configuration */
  431. #define change_volatile() \
  432.     change_private() \
  433.     vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
  434.  
  435. #define change_safe() \
  436.     vlc_config_set (p_config, VLC_CONFIG_SAFE);
  437.  
  438. /* Meta data plugin exports */
  439. #define VLC_META_EXPORT( name, value ) \
  440.     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
  441.     __VLC_SYMBOL(vlc_entry_ ## name) (void); \
  442.     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
  443.     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
  444.     { \
  445.          return value; \
  446.     }
  447.  
  448. #if defined (__LIBVLC__)
  449. # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
  450.     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
  451.     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
  452.     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
  453.     "\x6c\x6f\x70\x65\x72\x73" )
  454. #elif !defined (VLC_COPYRIGHT_EXPORT)
  455. # define VLC_COPYRIGHT_EXPORT
  456. #endif
  457. #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
  458.     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
  459.     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
  460.     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
  461.     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
  462.     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
  463.  
  464. #define VLC_METADATA_EXPORTS \
  465.     VLC_COPYRIGHT_EXPORT \
  466.     VLC_LICENSE_EXPORT
  467.  
  468. #endif
  469.